| resourceType | CommonPatient | 0..* | "Patient" | ALL DHBs | Fixed Value |
| id | string | 0..1 | "3490069" | ALL DHBs | For CMH, WDHB, NDHB: This is same value as NHI. For ADHB: This is the intenal Patient database index. |
| meta | Meta | 0..1 | | ALL DHBs | |
| ````meta.versionId | id | 0..1 | "0.4.5" | ALL DHBs | Indicates the Patient IG version number. |
| ````meta.lastUpdated | instant | 0..1 | | | The version of the patient record in PAS is not kept. Source data is also derived from several tables in source. So, timestamp may be different per table. |
| ````meta.source | uri | 0..1 | "CMS" | ALL DHBs | Identifies the PAS system where information was drawn from. Value is "CMS" for ADHB, "WebPAS" for NDHB and "iPM" for CMH and WDHB. |
| ````meta.profile | canonical(Structure Definition) | 0..* | (see comments) | ALL DHBs | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPatient |
| ````meta.security.code | code | 0..1 | "N" | ALL DHBs | Fixed Value |
| ````meta.security.display | string | 0..1 | "Normal" | ALL DHBs | Fixed Value |
| nz-ethnicity | Extension: CodeableConcept | 0..6 | | ALL DHBs | This structure contains the person's ethnicity which can be 1 or more (up to 6). |
| ````nz-ethnicity.url | uri | 1..1 | (see comments) | ALL DHBs | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity |
| ````nz-ethnicity.coding.system | uri | 0..1 | (see comments) | ALL DHBs | Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-4 |
| ````nz-ethinicity.code | code | 0..1 | "11" | ALL DHBs | NZPatient coding system was adopted and refers to ethnicity group level 4 but values surfaced from all DHBs are currently at ethnicity group level 2. |
| ````nz-ethnicity.display | string | 0..1 | "NZ European / Pakeha" | ALL DHBs | Display value may differ per DHB for the same ethnicity code. For example, ethnicity code "11" is "New Zealand European" for ADHB, "NZ European" for NDHB, "NZ European / Pakeha" for CMH and WDHB. |
| ````nz-ethnicity.text | string | | "NZ European / Pakeha" | ALL DHBs | Same as display value. |
| birth-place | Element | 0..1 | | ALL DHBs | Where the patient was born |
| ````birth-place.url | uri | 1..1 | (see comments) | ALL DHBs | Fixed Value: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
| ````birth-place.country | string | 0..1 | "New Zealand" | ALL DHBs | All DHBs have dropdown fields for user to choose the birth country. There is no free text field. |
| patient-iwi | CodeableConcept | 0..* | | NDHB | The iwi the person is associated with. Applicable to NDHB only |
| ````patient-iwi.url | uri | 1..1 | (see comments) | NDHB | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi |
| ````patient-iwi.coding.system | uri | 0..1 | (see comments) | NDHB | Fixed Value: https://standards.digital.health.nz/ns/iwi-code |
| ````patient-iwi.code | code | 0..1 | "MR" | NDHB | |
| ````patient-iwi.display | string | 0..1 | "Moriori" | NDHB | |
| ````patient-iwi.text | string | 0..1 | "Moriori" | NDHB | Same as display value |
| nz-residency-status | (Complex) | 0..1 | | ADHB, CMH, WDHB | |
| ````nz-residency-status-code | | | | ADHB, CMH, WDHB | |
| ````````nz-residency-status-code.url | uri | 1..1 | "status" | ADHB, CMH, WDHB | Fixed Value |
| ````````nz-residency-status-code.coding.system | uri | 0..1 | (see comments) | ADHB, CMH, WDHB | Fixed Value: https://standards.digital.health.nz/ns/nz-residency-status-code |
| ````````nz-residency-status-code.code | code | 0..1 | | ADHB, CMH, WDHB | |
| ````````nz-residency-status-code.display | string | 0..1 | | ADHB, CMH, WDHB | Display value may differ per DHB for the same code. For example, residency-status-code "Y" is "Yes" for WDHB, CMH and "New Zealand" for ADHB. |
| ````````nz-residency-status-code.text | string | 0..1 | | ADHB, CMH, WDHB | Same as display value. |
| ````nz-residency-status.url | uri | 1..1 | (see comments) | ADHB, CMH, WDHB | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status |
| nz-citizenship | (Complex) | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| sex-at-birth | Extension: CodeableConcept | 0..1 | | ALL DHBs | WDHB and CMH capture gender and birth sex as separate fields in PAS whereas ADHB and NDHB use the same field for both gender and birth sex. |
| ````sex-at-birth.url | uri | 1..1 | (see comments) | ALL DHBs | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth |
| ````sex-at-birth.coding.system | uri | 0..1 | (see comments) | ALL DHBs | Fixed Value: http://hl7.org/fhir/administrative-gender |
| ````sex-at-birth.code | code | 0..1 | "U" | ALL DHBs | "Possible values are "F", "M" and "U". "O" code is not used for birth-sex." |
| ````sex-at-birth.display | string | 0..1 | unknown | ALL DHBs | Possible values are "female", "male", "unknown" only. |
| ````sex-at-birth.text | string | 0..1 | | ALL DHBs | Same as display value. |
| current-occupation | Extension: CodeableConcept | 0..1 | | ALL DHBs | |
| ````current-occupation.url | uri | 1..1 | (see comments) | ALL DHBs | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/current-occupation |
| ````current-occupation.coding.system | uri | 0..1 | | n/a | There is no system value defined yet for current-occupation. |
| ````current-occupation.code | code | 0..1 | "F51" | CMH, NDHB, WDHB | CMH and WDHB uses the same code valueset whereas NDHB has its own. |
| ````current-occupation.display | string | 0..1 | "Forestry" | ALL DHBs | There is no standard values. Occupation is a free text field in ADHB PAS. |
| ````current-occupation.text | string | 0..1 | "Forestry" | ALL DHBs | Same as display value. |
| interpreter-required | Extension: Boolean | 0..1 | | ALL DHBs | Whether the patient needs an interpreter |
| ````interpreter-required.url | uri | 1..1 | (see comments) | ALL DHBs | Fixed Value: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
| ````interpreter-required.value | boolean | 0..1 | true | ALL DHBs | Possible values are true or false. |
| identifier[i] | Identifier | 0..* | | ALL DHBs | First identifier occurrence holds the NHI. Subsequent occurrences can be minor NHI or other identifiers used by the patient. Please note that for non-production environments, only NHIs starting with Z will be surfaced by the Patient FHIR API. |
| ````identifier: nhi-id | Identifier | 0..1 | | ALL DHBs | |
| ````````identifier.use | code | 1..1 | "official" | ALL DHBs | Fixed Value |
| ````````identifier.type | CodeableConcept | 0..1 | | ALL DHBs | |
| ````````````identifier.type.coding.system | uri | 0..1 | (see comments) | ALL DHBs | Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| ````````````identifier.type.code | code | 0..1 | "MR" | ALL DHBs | Fixed Value |
| ````````````identifier.type.display | string | 0..1 | "Medical Record" | ALL DHBs | Fixed Value |
| ```````````identifier.type.text | string | 0..1 | "Medical Record" | ALL DHBs | Same as display value. |
| ````````identifier.system | uri | 0..1 | (see comments) | ALL DHBs | Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
| ````````identifier value | string | 0..1 | "ZZZ0075" | ALL DHBs | Contains the patient NHI. If the input NHI is a minor NHI, the API will always return the primary NHI number as the first patient identifier. NHI format can either be the current or new NHI format. Current NHI format is AAANNNAC and New NHI Format is AAANNAX where A ā is an alphabetic character but not āIā or āOā, N ā is a number 0ā9, C ā is a numeric check digit, X is a alpha check digit. |
| ````identifier: nhi-id (dormant nhi) | Identifier | 0..* | | ALL DHBs | |
| ````````identifier.use | code | 1..1 | "old" | ALL DHBs | Fixed Value |
| ````````identifie.type | CodeableConcept | 0..1 | | ALL DHBs | |
| ````````````identifier.type.coding.system | uri | 0..1 | (see comments) | ALL DHBs | Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| ````````````identifier.type.code | code | 0..1 | "MR" | ALL DHBs | Fixed Value |
| ````````````identifier.type.display | string | 0..1 | "Medical Record" | ALL DHBs | Fixed Value |
| ```````````identifier.type.text | string | 0..1 | | ALL DHBs | Same as display value. |
| ````````identifier.system | uri | 0..1 | (see comments) | ALL DHBs | Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
| ````````identifier value | string | 0..1 | "ZZZ0074" | ALL DHBs | If the input NHI is a minor NHI, the API will always return the primary NHI as the first patient identifier followed by the minor NHI. On the otherhand, if input NHI is the primary NHI, the the API will return the minor NHI as a secondary patient identifier if one exists for the patient. |
| ````identifier: otherIdentifiers | Identifier | 0..* | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| name[i] | HumanName | 1..* | | ALL DHBs | This structure can hold multiple names of a patient: official name and aliases. Note that in ADHB, some patient names are stored in all capital letters for first and last names. |
| ````preferred name | Extension: Boolean | 0..* | | ALL DHBs | |
| ````````preferred name.url | uri | 1..1 | (see comments) | ALL DHBs | Fixed Value: http://hl7.org/fhir/StructureDefinition/iso21090-preferred |
| ````````preferred name.value | boolean | 0..1 | true | ALL DHBs | Possible values are true or false. If value is true, then the name occurrence is the preferred name of the patient. |
| ````name.use | code | 0..1 | "official" | ALL DHBs | "usual" is used for preferred name.For AHDB, possible values are for "official", "usual", "nickname" (for aliases). For NDHB, possible values are "usual", "nickname" (for aliases). For WDHB and CMH, possible values are "usual", "old" (for aliases)." |
| ````name.text | string | 0..1 | "Ms Mary Anne Smith" | ALL DHBs | This is a concatenation of patient name prefix, give names and family name. |
| ````name.family | string | 0..1 | "Smith" | ALL DHBs | Contains the surname of the patient. |
| ````name.given[x] | string | 0..* | "Mary", "Anne" | ALL DHBs | Contains the multiple given names of a patient. ADHB, CMH and WDHB provides first name, second name and third name. NDHB can provide more than 3 given names. |
| ````name.prefix[x] | string | 0..* | "Ms" | ALL DHBs | Contains the title of the patient. |
| telecom[i] | ContactPoint | 0..* | | ALL DHBs | This structure holds the different contact details of the patient. Possible system/use combinations for all DHBs are phone/ mobile, phone/home, email/ home. ADHB also provides system/use combinations of other/home, phone/work, fax/work. For WDHB, CMDHB, only verified emails will be returned. |
| ````telecom.authorized-by-patient | Extension: Boolean | 0..* | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| ````telecom.validated-by-patient | Extension: Boolean | 0..* | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| ````telecom.system | code | 0..1 | "phone" | ALL DHBs | Possible values are "phone", "fax", "email", "other". Values "url" and "sms" are not used. |
| ````telecom.value | string | 0..1 | 271234567 | ALL DHBs | Value may be a phone number or email address |
| ````telecom.use | code | 0..1 | "mobile" | ALL DHBs | Possible values are "home", "work", "mobile". Values "temp" and "old" are not used. |
| gender | code | 1..1 | "unknown" | ALL DHBs | This field is use for gender identity. Possible values are "female", "male", "unknown". "other" is presently not used. For ADHB and NDHB, gender diverse is presented as "unknown". |
| birthDate | date | 1..1 | "1996-08-26" | ALL DHBs | This field only contains birth date but not birth time. Format is YYYY-MM-DD. |
| deceased | | | | ALL DHBs | This structure either presents deceasedDate or deceasedBoolean but not both. |
| ````deceasedBoolean | boolean | 0..1 | true | ALL DHBs | Possible values are true or false. |
| ````deceasedDateTime | dateTime | 0..1 | "2020-08-08" | ALL DHBs | This field only contains death date but not death time. Format is YYYY-MM-DD. |
| address[i] | NzAddress | 1..* | | ALL DHBs | This structure can contain the different addresses of a patient which includes residential and mailing addresses. It does not include patient work address. Possible Use/Type combinations are: home/ physical, home/ postal. |
| ````address.id | string | 0..1 | | n/a | Not used |
| ````address.nz-geocode | (Complex) | 0..* | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| ````address.suburb | Extension: String | 0..* | | ADHB | Not used by CMH, NDHB and WDHB. |
| ````````address.suburb.url | uri | 1..1 | (see comments) | ADHB | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/suburb |
| ````````address.suburb.value | string | 0..1 | "Pakuranga Heights" | ADHB | |
| ````address.building-name | Extension: String | 0..* | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| ````address.domicile | Extension; Codeable Concept | 0..1 | | ALL DHBs | |
| ````````address.domain.url | uri | 1..1 | (see comments) | ALL DHBs | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/domicile-code |
| ````````address.domain.coding.system | uri | 0..1 | (see comments) | ALL DHBs | Fixed Value: https://standards.digital.health.nz/ns/domicile-code |
| ````````address.domain.code | code | 0..1 | "11" | ALL DHBs | Domicile code associated to the address. For NDHB, value is always "011" for Northland. |
| ````````address.domain.display | string | 0..1 | "Northland" | NDHB | Not used by ADHB, CMH and WDHB. |
| ````````address.domain.text | string | 0..1 | "Northland" | NDHB | Same as display value. |
| ````address.authorized-by-patient | Extension: Boolean | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| ````address.validated-by-patient | Extension: Boolean | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| ````address.use | code | 0..1 | "home" | ALL DHBs | Possible values are: "home". Values "work", "temp", "old", "billing" are not used. |
| ````address.type | code | 0..1 | "physical" | ALL DHBs | Possible values are: "postal" for correspondence address and "physical" for residential address. Value "both" is not used. |
| ````address.text | string | 0..1 | (see comments) | ALL DHBs | This is the concatenation of address lines 1 to 4, postal code, country with "," (comma) as delimiter. For example - "6A Edgerley Avenue,,Epsom,Auckland,1023,New Zealand" |
| ````address.line[x] | string | 0..* | | ALL DHBs | Contains patient address line 1 to 4. Addresses are presented in the format that they are stored in PAS except compression is applied where there are blank line in between and postcode is removed from the last address line. |
| ````````address.line[1] | string | | "6A Edgerley Avenue" | ALL DHBs | |
| ````````address.line[2] | string | | "Epsom" | ALL DHBs | |
| ````````address.line[3] | string | | "Auckland" | ALL DHBs | |
| ````````address.line[4] | string | | | ALL DHBs | |
| ````address.city | string | 0..1 | "Auckland" | ADHB | Not used by CMH, NDHB and WDHB. |
| ````address.postalCode | string | 0..1 | "1023" | ALL DHBs | Note: For NDHB, postcode is currently showing the domicile code until DXC fixes WebPAS. |
| ````address.country | string | 0..1 | "New Zealand" | ALL DHBs | |
| maritalStatus | CodeableConcept | 0..1 | | ALL DHBs | |
| ````maritalStatus.coding.system | uri | 0..1 | (see comments) | ALL DHBs | Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus |
| ````maritalStatus.code | code | 0..1 | "M" | ALL DHBs | There is no standard code values. |
| ````maritalStatus.display | string | 0..1 | "Married" | ALL DHBs | Display value may differ per DHB for the same code. |
| ````maritalStatus.text | string | | "Married" | ALL DHBs | Same as display value. |
| contact[i] | BackboneElement | 0..* | | ALL DHBs | This structure contains the contact person details of the patient. ADHB PAS can have primary and alternate contacts. CMH PAS does not have Next of Kin information but only Emergency Contacts. NDHB can return multiple contact types (i.e., emergency, next of kin or others). For WDHB, first occurrence is for Next of Kin, 2nd occurrence for Emergency Contact and 3rd occurrence for Caregiver. |
| ````contact.relationship | CodeableConcept | 0..* | | ALL DHBs | |
| ````````contact.relationship.coding.system | uri | 0..1 | (see comments) | ALL DHBs | Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 |
| ````````contact.relationship.code | code | 0..1 | "04" | ALL DHBs | Possible values are "N" for Next of Kin, "C" for emergency contacts, "O" for other contacts |
| ````````contact.relationship.display | string | 0..1 | "Brother" | ALL DHBs | Possible values are "Next of Kin", "Emergency Contact", "Other" |
| ````````contact.relationship.text | string | 0..1 | "Brother" | ALL DHBs | Same as display value. |
| ````contact.name | HumanName | 0..1 | | ALL DHBs | |
| ````````contact.name.use | code | 0..1 | "usual" | ALL DHBs | Fixed Value |
| ````````contact.name.text | string | 0..1 | "Mr Just Jeans" | ALL DHBs | This is a concatenation of patient name prefix (title), give names and family name. |
| ````````contact.name.family | string | 0..1 | "Jeans" | ALL DHBs | Contains the surname of the patient. |
| ````````contact.name.given[x] | string | 0..* | "Just" | ALL DHBs | Contains the multiple given names of a patient. ADHB, CMH and WDHB provides first name, second name and third name. NDHB can provide more than 3 given names. |
| ````````contact.name.prefix[x] | string | 0..* | "Mr" | ALL DHBs | Contains the title of the patient. |
| ````contact.telecom[x] | ContactPoint | 0..* | | ALL DHBs | |
| ````````contact.telecom.system | code | 0..1 | "other" | ALL DHBs | Possible values are "phone", "fax", "email", "other". Values "url" and "sms" are not used. |
| ````````contact.telecom.value | string | 0..1 | "01234" | ALL DHBs | Value may be a phone number or email address |
| ````````contact.telecom.use | code | 0..1 | "home" | ALL DHBs | Possible values are "home", "work", "mobile". Values "temp" and "old" are not used. |
| ````contact.address | Address | 0..1 | | ADHB, CMH, WDHB | Not used by NDHB |
| ````````contact.address.use | code | 0..1 | "home" | ADHB, CMH, WDHB | Possible values are: "home". Values "work", "temp", "old", "billing" are not used. |
| ````````contact.address.type | code | 0..1 | "physical" | ADHB, CMH, WDHB | Possible values are: "postal, "physical". Value "both" is not used." |
| ````````contact.address.line[x] | string | 0..* | | ADHB, CMH, WDHB | Contains patient address line 1 to 4. Addresses are presented in the format that they are stored in PAS except compression is applied where there are blank line in between and postcode is removed from the last address line. |
| ````````````contact.address.line[1] | string | | "6A Edgerley Avenue" | ADHB, CMH, WDHB | |
| ````````````contact.address.line[2] | string | | "Epsom" | ADHB, CMH, WDHB | |
| ````````````contact.address.line[3] | string | | "Auckland" | ADHB, CMH, WDHB | |
| ````````````contact.address.line[4] | string | | | ADHB, CMH, WDHB | |
| ````````contact.address.city | string | 0..1 | "Auckland" | ADHB | |
| ````````contact.address.district | string | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| ````````contact.address.state | string | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| ````````contact.address.postalCode | string | 0..1 | "1023" | CMH, WDHB | |
| ````````contact.address.country | string | 0..1 | "New Zealand" | ADHB, CMH, WDHB | |
| ````contact.gender | code | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| communication[i] | BackboneElement | 0..* | | ALL DHBs | Language(s) which may be used to communicate with the patient about his or her health. |
| ````communication.language | CodeableConcept | 1..1 | | ALL DHBs | |
| ````````communication.language.system | uri | 0..1 | urn:ietf:bcp:47 | ALL DHBs | Fixed Value |
| ````````communication.language.code | code | 0..1 | "11" | ALL DHBs | ADHB and NDHB uses numeric codes while CMH and WDHB are using alpha codes, example "FIJIAN". |
| ````````communication.language.display | string | 0..1 | "Chinese - Teochoew" | ALL DHBs | |
| ````````communication.language.text | string | 0..1 | "Chinese - Teochoew" | ALL DHBs | Same as display value. |
| generalPractitioner[i] | Reference(Northern Region PractitionerRole profile) | 0..* | | ALL DHBs | Patient's nominated primary care provider |
| ````generalPractitioner.id | string | 0..1 | "4a5c03bf-3495-4e08-a7b8-d6855671c754" | ALL DHBs | This is the internal database unique ID of the practitioner in PAS. |
| ````generalPractitioner.gp-practice-enrollment-date | Extension: Date | 0..* | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
| ````generalPractitioner.reference | string | 0..1 | (see comments) | ALL DHBs | Contains a string that is a concatenation of "PractitionerRole/" and the unique ID of the practitioner in PAS. Example: "PractitionerRole/4a5c03bf-3495-4e08-a7b8-d6855671c754" |
| ````generalPractitioner.display | string | 0..1 | "Dr Benjamin Mark Comery" | ALL DHBs | This is the concatenation of the general practitioner's title, family name and given names. Note: For WDHB, patients with no GP or Practice uses a dummy GP called "Non-Ipm H.C.P." |
| managingOrganization | Reference {Organization} | 0..1 | | ALL DHBs | Organization that is the custodian of the patient record. |
| ````managingOrganization.reference | string | 0..1 | "Organization/304800141192" | ALL DHBs | Possible values are "304800141192" for ADHB, "304800141193" for CMH, "304800141205" for NDHB and "304800141194" for WDHB. |
| ````managingOrganization.identifier | Identifier | 0..1 | "ADHB" | ALL DHBs | Possible values are: "ADHB", "CMH", "NDHB", "WDHB" |
| ````managingOrganization.display | string | 0..1 | (see comments) | ALL DHBs | Possible values are: "Auckland District Health Board", "Counties and Manukau District Health Board", "Northland District Health Board" and "Waitemata District Health Board". |